IBM InfoROM for OS/2 Beta 1995 January

home *** CD-ROM | disk | FTP | other *** search

/ IBM InfoROM for OS/2 Beta 1995 January / IBM InfoROM for OS2 Beta 1-1995.ISO / testcert / storage / function / cdrom / global.gra < prev next >

Wrap

Text File | 1994-10-10 | 18.3 KB | 427 lines

****************************************************************************** ** GLOBAL.GRA DESCRIPTION FILE ** ****************************************************************************** ** GLOBAL FUNCTION CALLS ** ****************************************************************************** SET $DLL=GLOBAL \ $FUNC=_set ** ** THIS FUNCTION SETS A VARIABLE EQUAL TO THE PASSED VALUE. THIS FUNCTION ** NEEDS BOTH THE VARIABLE AND VALUE. ** ** NEEDED PARAMETERS: VARIABLE ** VALUE ** ** EXAMPLE: SET DEVICENAME=E: ** ** RETURNS: SET VARIABLE ** ****************************************************************************** LOG $DLL=GLOBAL \ $FUNC=_log ** ** THIS FUNCTION WILL PLACE A TIME STAMP IN THE OUPUT FILE FOR THE SCRIPT ** FILE WHEN IT IS CALLED. IT CAN EITHER JUST LOG THE TIME OR IT CAN ALSO ** LOG THE TIME AND A MESSAGE IN THE SAME CALL. ** ** NEEDED PARAMETERS: MESSAGE TO BE DISPLAYED (OPTIONAL) ** ** EXAMPLE: LOG - TIME STAMP ** LOG $PROMPT="message" - TIME STAMP & MESSAGE ** ** RETURNS: NOTHING ** ****************************************************************************** RESPONSE $DLL=GLOBAL \ $FUNC=_input ** ** THIS FUNCTION WILL DISPLAY A MESSAGE AND THEN WAIT FOR A RESPONSE TO THE ** MESSAGE. THE AMOUNT OF TIME THAT THE THREAD WILL WAIT FOR THE RESPONSE ** CAN BE SET WITH THE PAUSE COMMAND. IF A VALUE OF -1 IS PASSED, THE THREAD ** WILL WAIT INDEFINITELY UNTIL THE ENTER KEY IS PRESSED. ** ** NEEDED PARAMETERS: MESSAGE TO BE DISPLAYED ** TIME TO WAIT FOR RESPONSE - IN SECONDS ** ** EXAMPLE: RESPONSE $PROMPT="message" $PAUSE=seconds ** ** RETURNS: NOTHING ** ****************************************************************************** DUMP $DLL=GLOBAL \ $BUFFER=STRING \ $FUNC=_dump ** ** THIS FUNCTION WILL PLACE THE CONTENTS OF A BUFFER IN THE LOG FILE. ** ** NEEDED PARAMETERS: BUFFER OF DATA ** ** EXAMPLE: SET BUFFER=ALPHA - SET BUFFER ** CDROM_READFILE - FILL BUFFER ** DUMP $BUFFER=ALPHA - DUMP BUFFER ** ** RETURNS: NOTHING ** ****************************************************************************** PAUSE $DLL=GLOBAL \ $PAUSE=NUM \ $FUNC=_pause ** ** THIS FUNCTION WILL PAUSE THE THREAD FOR A CERTAIN AMOUNT OF TIME. ** THE AMOUNT OF TIME THAT THE THREAD WILL WAIT NEEDS TO BE PASSED TO THE ** FUNCTION. ** ** NEEDED PARAMETERS: TIME TO WAIT - IN SECONDS ** ** EXAMPLE: PAUSE $PAUSE=seconds ** ** RETURNS: NOTHING ** ****************************************************************************** OUT $DLL=GLOBAL \ $KWD=STRING \ $FUNC=_out ** ** THIS FUNCTION WILL OUTPUT THE VALUE OF A KEYWORD FROM THE KEYWORD LIST. ** ** NEEDED PARAMETERS: KEYWORD ** ** EXAMPLE: CD OUT $KWD=DEVICENAME ** ** RETURNS: VALUE OF KEYWORD ** ****************************************************************************** CLEAR $DLL=GLOBAL \ $BUFFER=STRING \ $FUNC=_clear ** ** THIS FUNCTION WILL CLEAR THE CONTENTS OF A BUFFER BY SETTING ALL OF THE ** BITS TO 0'S. ** ** NEEDED PARAMETERS: BUFFER ** ** EXAMPLE: SET BUFFER=BETA - SET BUFFER ** CDROM_READFILE - FILL BUFFER ** CLEAR $BUFFER=BETA - CLEAR BUFFER ** ** RETURNS: NOTHING ** ****************************************************************************** COMPARE $DLL=GLOBAL \ BUFFER1=STRING \ BUFFER2=STRING \ $FUNC=_compare ** ** THIS FUNCTION WILL COMPARE THE CONTENTS OF 2 BUFFERS. IT WILL EITHER RETURN ** A BUFFER COMPARE SUCCESS OR A BUFFER COMPARE FAILURE. ** ** NEEDED PARAMETERS: BUFFER1 ** BUFFER2 ** ** EXAMPLE: SET BUFFER=ALPHA ** cd set SECTORSTART=20 ** cd set SECTORCOUNT=400 ** cd set ADDRESSMODE=LOGICALBLOCK ** cd CDROM_OPEN ** cd CDROM_READ2048 ** @loop 2 ** cd CDROM_READ2048 BUFFER=BETA ** cd COMPARE BUFFER1=ALPHA BUFFER2=BETA ** cd CLEAR $BUFFER=BETA ** @endloop ** ** RETURNS: RESULTS OF BUFFER COMPARE ** ****************************************************************************** DECREMENT $DLL=GLOBAL \ $COUNT=NUM \ $FUNC=_decrement ** ** THIS FUNCTION WILL DECREMENT THE LOOP COUNTER VARIABLE BY 1 EACH TIME IT IS ** INCOUNTERED. ** ** NEEDED PARAMETERS: LOOP COUNTER ** ** EXAMPLE: SET BUFFER=BETA - SET BUFFER ** CDROM_QUERYAUDIODISKINFO ** set $COUNT=$(HIGHTRACK) ** response $PROMPT="QUERYING AUDIO TRACK INFO" ** @loop [alias name, hightrack] ** set track=$($COUNT) ** CDROM_QUERYAUDIOTRACKINFO ** DECREMENT ** @endloop ** ** RETURNS: LOOPCOUNTER ** ****************************************************************************** INCREMENT $DLL=GLOBAL \ $COUNT=NUM \ $FUNC=_increment ** ** THIS FUNCTION WILL INCREMENT THE LOOP COUNTER VARIABLE BY 1 EACH TIME IT IS ** INCOUNTERED. ** ** NEEDED PARAMETERS: LOOP COUNTER ** ** EXAMPLE: SET BUFFER=BETA - SET BUFFER ** CDROM_QUERYAUDIODISKINFO ** set $COUNT=$(LOWTRACK) ** response $PROMPT="QUERYING AUDIO TRACK INFO" ** @loop [alias name, hightrack] ** set track=$($COUNT) ** CDROM_QUERYAUDIOTRACKINFO ** INCREMENT ** @endloop ** ** RETURNS: LOOPCOUNTER ** ****************************************************************************** LABEL $DLL=GLOBAL \ $LABEL=STRING \ $FUNC=_label ** ** THIS FUNCTION WILL ASSOCIATE A NAME(LABEL) WITH A LINE. AFTER A ** LINE HAS BEEN LABELED, GOTO CAN BE USED TO JUMP TO IT. ** ** NEEDED PARAMETERS: LABEL NAME ** ** EXAMPLE: CD LABEL $LABEL="test" - NAMES LINE ** CD GOTO $LABEL="test" - GOTOS LINE ** ** RETURNS: NOTHING ** ****************************************************************************** PROC $DLL=GLOBAL \ $LABEL=STRING \ $LINES=NUM \ $FUNC=_proc ** ** THIS FUNCTION WILL CREATE A PROCEDURE AND DEFINE ALL OF THE STATEMENTS ** THAT ARE IN THAT PROCEDURE. WHEN YOU DEFINE THE PROCEDURE, YOU MUST ** ALSO LIST THE LABEL NAME AND THE NUMBER OF LINES IN THE PROCEDURE. THE ** PROCEDURE LINE SHOULD NOT BE INCLUDED IN THE LINE COUNT. THE RETURN LINE ** SHOULD BE INCLUDED IN THE LINE COUNT. ** ** NEEDED PARAMETERS: LABEL NAME ** # OF LINES ** PROCEDURE FUNCTIONS ** ** EXAMPLE: PROC $LABEL="test" $LINES=6 ** CDROM_OPEN ** CDROM_LOCKDOOR ** CDROM_QUERYCHANNELINFO ** CDROM_UNLOCKDOOR ** CDROM_CLOSE ** RETURN ** ** RETURNS: NOTHING ** ****************************************************************************** GOTO $DLL=GLOBAL \ $LABEL=STRING \ $FUNC=_jump ** ** THIS FUNCTION WILL GOTO A PARTICULAR LABELED LINE WHEN THIS LINE IS ** INCOUNTERED IN A SCRIPT FILE. ** ** NEEDED PARAMETERS: LABEL NAME ** ** EXAMPLE: GOTO $LABEL="test" ** ** RETURNS: NOTHING ** ****************************************************************************** CALL $DLL=GLOBAL \ $LABEL=STRING \ $FUNC=_call ** ** THIS FUNCTION WILL CALL A PARTICULAR PROCEDURE WHEN THIS LINE IS ** INCOUNTERED IN A SCRIPT FILE. WHEN THE PROCEDURE HAS FINISHED, (AND A RETURN ** STATEMENT IS ENCOUNTERED) IT WILL JUMP BACK TO THE NEXT LINE IN THE ** SCRIPT FILE. ** ** NEEDED PARAMETERS: LABEL NAME ** ** EXAMPLE: CALL $LABEL="test" ** ** RETURNS: NOTHING ** ****************************************************************************** RETURN $DLL=GLOBAL \ $FUNC=_ret ** ** THIS FUNCTION SIGNIFIES THE END OF A PROCEDURE. WHEN THIS LINE IS ** INCOUNTERED IN A PROCEDURE, THE FLOW OF CONTROL WITH RETURN TO THE LINE ** WHERE THE PROCEDURE WAS CALLED FROM. ** ** NEEDED PARAMETERS: NOTHING ** ** EXAMPLE: PROC $LABEL="test" $LINES=6 ** CDROM_OPEN ** CDROM_LOCKDOOR ** CDROM_QUERYCHANNELINFO ** CDROM_UNLOCKDOOR ** CDROM_CLOSE ** RETURN ** ** RETURNS: NOTHING ** ****************************************************************************** ADD $DLL=GLOBAL \ $OP1=STRING \ $OP2=STRING \ $RESULT=STRING \ $FUNC=_add ** ** THIS FUNCTION WILL ADD 2 VARIABLES AND PLACE THE SUM IN A RESULT STRING. ** ** NEEDED PARAMETERS: 2 VARIABLES THAT WILL BE ADDED ** RESULT VARIABLE ** ** EXAMPLE: SET VAL1=2 ** SET VAL2=10 ** ADD $OP1=$(VAL1) $OP2=$(VAL2) $RESULT=SUM ** ** RETURNS: RESULT VARIABLE ** ****************************************************************************** SUB $DLL=GLOBAL \ $OP1=STRING \ $OP2=STRING \ $RESULT=STRING \ $FUNC=_sub ** ** THIS FUNCTION WILL SUBTRACT 1 VARIABLE FROM ANOTHER VARIABLE AND PLACE THE ** DIFFERENCE IN A RESULT STRING. ** ** NEEDED PARAMETERS: 2 VARIABLES THAT WILL BE ADDED ** RESULT VARIABLE ** ** EXAMPLE: SET VAL1=10 ** SET VAL2=3 ** SUB $OP1=$(VAL1) $OP2=$(VAL2) $RESULT=SUM ** ** RETURNS: RESULT VARIABLE ** ****************************************************************************** IF $DLL=GLOBAL \ $FUNC=_IF ** ** THIS FUNCTION WILL SKIP THE NEXT LINE IF THE $COND KEYWORD IS UNDEFINED OR ZERO. ** ** NEEDED PARAMETERS: CONDITION VARIABLE ** ** EXAMPLE: SET SUPPORTED=1 ** IF $COND=$(SUPPORTED) ** response $PROMPT="SUPPORTED" $PAUSE=0 ** CDROM_LOCKDOOR ** ** RETURNS: CONDITION VARIABLE ** ****************************************************************************** DOFOR $DLL=GLOBAL \ $FUNC=_doloop ** ** THIS FUNCTION WILL LOOP UNTIL THE RESULT VARIABLE $COND IS EQUAL TO ZERO. ** THIS FUNCTION WILL AUTOMATICALLY INCREMENT $I BY 1 EACH TIME THROUGH THE ** LOOP. THIS SIGNIFIES THE START OF THE LOOP. THE LOOP WILL BE EXECUTED AT ** LEAST ONCE. ** ** NEEDED PARAMETERS: EXPRESSION TO BE EVALUATED ** ** EXAMPLE: SET $I=0 ** DOFOR ** SUB $OP1=10 $OP2=$($I) ** @PAUSE 5 ** ENDFOR ** ** RETURNS: none ** ****************************************************************************** ENDFOR $DLL=GLOBAL \ $FUNC=_endfor ** ** THIS FUNCTION WILL LOOP UNTIL THE RESULT VARIABLE $COND IS EQUAL TO ZERO. ** THIS FUNCTION WILL AUTOMATICALLY INCREMENT $I BY 1 EACH TIME THROUGH THE ** LOOP. THIS SIGNIFIES THE END OF THE LOOP. THE LOOP WILL BE EXECUTED AT ** LEAST ONCE. ** ** NEEDED PARAMETERS: EXPRESSION TO BE EVALUATED ** ** EXAMPLE: SET $I=0 ** SET $RESULT=$COND ** DOFOR ** SUB $OP1=10 $OP2=$($I) ** @PAUSE 5 ** ENDFOR ** ** RETURNS: $COND ** ****************************************************************************** DOWHILE $DLL=GLOBAL \ $RESULT=STRING \ $FUNC=_doloop ** ** THIS FUNCTION WILL LOOP UNTIL THE RESULT VARIABLE IS EQUAL TO ZERO. ** THIS FUNCTION DOES NOT AUTOMATICALLY INCREMENT $I BY 1 EACH TIME THROUGH THE ** LOOP. THIS SIGNIFIES THE START OF THE LOOP. THE LOOP WILL BE EXECUTED AT ** LEAST ONCE. ** ** NEEDED PARAMETERS: EXPRESSION TO BE EVALUATED ** RESULT VARIABLE ** ** EXAMPLE: DOWHILE ** RESPONSE $PROMPT="ENTER 0 TO CONTINUE" \ ** $RESPONSE=$COND $PAUSE=-1 ** ENDWHILE ** ** RETURNS: RESULT VARIABLE ** ****************************************************************************** ENDWHILE $DLL=GLOBAL \ $RESULT=STRING \ $FUNC=_endwhile ** ** THIS FUNCTION WILL LOOP UNTIL THE RESULT VARIABLE IS EQUAL TO ZERO. ** THIS FUNCTION DOES NOT AUTOMATICALLY INCREMENT I BY 1 EACH TIME THROUGH THE ** LOOP. THIS SIGNIFIES THE END OF THE LOOP. THE LOOP WILL BE EXECUTED AT ** LEAST ONCE. ** ** NEEDED PARAMETERS: EXPRESSION TO BE EVALUATED ** RESULT VARIABLE ** ** EXAMPLE: DOWHILE ** RESPONSE $PROMPT="ENTER 0 TO CONTINUE" \ ** $RESPONSE=$COND $PAUSE=-1 ** ENDWHILE ** ** RETURNS: RESULT VARIABLE ** ****************************************************************************** MAKEIMPORT $DLL=GLOBAL \ $FUNC=_filedump \ $FILENAME=STRING \ $COMMAND=STRING \ $ALIAS=STRING ** ** THIS FUNCTION CREATES A FILE OF $FILENAME, PUTS THE STRING "$ALIAS $COMMAND" ** IN THE FILE, ALSO, NOT REQUIRED, BUT CAN BE SPECIFIED ARE $KWD AND $VALUE. ** ** NEEDED PARAMETERS: $FILENAME - FILE TO CTREATE ** $COMMAND - COMMAND ** $ALIAS - ALIAS ** ** EXAMPLE: ALIAS MAKEIMPORT \ ** $FILENAME=IMPORT.TXT \ ** $ALIAS=ALIAS \ ** $COMMAND=COMMAND ** ** ** RETURNS: NONE. ** ******************************************************************************